home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / qscrub_1.zip / QSCRUB.DOC next >
Text File  |  1989-04-13  |  9KB  |  331 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                           = = = = = = = = = = = = = =
  20.                           =                         =
  21.                           = QuickScrub Version 1.00 =
  22.                           =                         =
  23.                           = = = = = = = = = = = = = =
  24.  
  25.  
  26.                     The Dirty-Word Detergent and Scrub Brush
  27.                         For Text Files and Message Bases
  28.                         Cleans - Disinfects - Deodorizes
  29.  
  30.  
  31.                             Written by Jason A. Cox
  32.                      Copyright (C)1989 All Rights Reserved
  33.  
  34.  
  35.                        Support Board: ComTron DataCentre
  36.                                FidoNet 1:170/500
  37.                                  (918)245-5633
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                  QuickScrub Version 1.00 User's Guide - Page 1
  70.  
  71.  
  72.  
  73.                                   INTRODUCTION
  74.  
  75.          QuickScrub will read  a  user defined list of dirty-words (or
  76.          phrases) into memory and search  the  specified  file for any
  77.          occurrence.  If a match is found, it will replace that phrase
  78.          with a user-defined  mask  character  such  as  an  asterisk.
  79.          QuickScrub is capable  of handling several types of files, as
  80.          well as the  QuickBBS  message   base.    Because   of   this
  81.          flexibility, and the  ability  to  use wildcards  it  is  not
  82.          limited to any one message system or a message system at all.
  83.  
  84.  
  85.                                   REGISTRATION
  86.  
  87.          QuickScrub and this  document  are  copyrighted  material  of
  88.          Jason Cox.  You are granted a  limited  license  to use, copy
  89.          and distribute QuickScrub  providing  you use  the  following
  90.          Shareware guidelines:  No  fee  is  charged  for  the  use or
  91.          distribution (not including the  media)  of QuickScrub or its
  92.          support files.  QuickScrub   must  be  distributed   in   its
  93.          original, unmodified state  (excluding  compression/archiving
  94.          methods).
  95.  
  96.          If after you  have  tested  QuickScrub  on  your  system  and
  97.          determine that it is suitable for your application,  you  are
  98.          required to register your copy.
  99.  
  100.          To register your copy send $10 to:
  101.  
  102.                            Jason Cox
  103.                            3102 South Summit Blvd.
  104.                            Sand Springs, OK 74063
  105.  
  106.          Please include your  name,  address,  phone  number,  and  if
  107.          applicable, your FidoNet node number.  Site licensing request
  108.          and request for licensing exclusion  should  also  be sent to
  109.          the above address or FidoNet 1:170/500.
  110.  
  111.          Upon registration you  will receive an acknowledgment  letter
  112.          via FidoNet or your address and a registered update.
  113.  
  114.          QuickScrub comes with  no  guarantee;  however,  serious bugs
  115.          that are reported will be promptly acted upon.
  116.  
  117.  
  118.                                 HOW TO SET IT UP
  119.  
  120.          QuickScrub is fairly easy to use.   However,  there are a few
  121.          things that must  be  done  in order to run QuickScrub.   The
  122.          first, and most  important, is the creation of the Dirty-Word
  123.          control file.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                  QuickScrub Version 1.00 User's Guide - Page 2
  136.  
  137.  
  138.  
  139.                               THE DIRTY-WORD LIST
  140.  
  141.          The first thing  that must be done in order to run QuickScrub
  142.          is to create  the Dirty-Word list:  QSCRUB.LST.   This  is  a
  143.          simple text file  that contains a list of up to  forty  words
  144.          and phrases.  Each phrase-line is limited to forty characters
  145.          and must end in a carriage return.
  146.  
  147.          The first line   and  first  character  of  QSCRUB.LST   MUST
  148.          contain the mask character that  you want QuickScrub to write
  149.          over the dirty-words.  Any character (with the exception of a
  150.          carriage return or  an end of file) is considered  legal  and
  151.          may be used as the mask character.  On the next line, and the
  152.          lines that follow, you enter the phrases to be masked.
  153.  
  154.          An example QSCRUB.LST file:
  155.  
  156.               *
  157.               foul
  158.               filthy phrase
  159.               filthy
  160.               3 unwanted words
  161.               etc...
  162.  
  163.          This would instruct  QuickScrub to replace any of the phrases
  164.          (IE: foul) with the asterisk character (IE: ****).
  165.  
  166.          You will notice  that  I  placed   "filthy   phrase"   before
  167.          "filthy".  Because QuickScrub   will   search   and   replace
  168.          according to the  order  of  the  QSCRUB.LST  file,  if I had
  169.          placed "filthy" before the other,  QuickScrub would never see
  170.          "filthy phrase", but  instead, it would see "******  phrase",
  171.          and thus the phrase would only be partially masked.
  172.  
  173.          Similar to the   search  and  replace  functions  of  various
  174.          editors, QuickScrub will mask  out  phrases  no  matter where
  175.          they occur.  This  could even be inside a word.   Because  of
  176.          this, special care  needs  to be made in the determination of
  177.          the phrases to use.  A simple  word  such  as  "hello"  could
  178.          easily become "****o"  without  the  operator   knowing  what
  179.          happened.  To prevent  such  disasters,  leading and trailing
  180.          spaces can be placed around the  phrase  (Ie:  " foul ").  Be
  181.          sure that the  editor  you use doesn't axe off  the  trailing
  182.          space.
  183.  
  184.          NOTE: The number  of phrases to search for greatly determines
  185.          the amount of time QuickScrub takes to process a file.  It is
  186.          therefore better to use as few  phrases  as possible.  A four
  187.          or five phrase   list   should   be   sufficient   for   most
  188.          applications.
  189.  
  190.          Once the QSCRUB.LST  control file has been created and placed
  191.          in the same directory as QSCRUB.EXE, you are ready to run.
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.                  QuickScrub Version 1.00 User's Guide - Page 3
  202.  
  203.  
  204.  
  205.                              HOW TO USE QUICKSCRUB
  206.  
  207.          To get a  brief  summary  of  the  command line options, type
  208.          QSCRUB ?  at the DOS prompt.
  209.  
  210.          QSCRUB <FileName> <!>
  211.  
  212.          The <FileName> can  be  any  valid  DOS  filename,  including
  213.          drive, path, and wildcards.
  214.  
  215.          The <!> instructs QuickScrub to use direct-screen writes
  216.          for output.  This  is extremely useful when processing  large
  217.          files such as   the   QuickBBS  message  base.   If  you  are
  218.          processing several files (Ie:  *.doc),  this  option  is  not
  219.          advised.
  220.  
  221.  
  222.                                     EXAMPLES
  223.  
  224.          To help you understand how to use QuickScrub, I have included
  225.          a few examples:
  226.  
  227.  
  228.          A wildcard example to scrub the mail packets  as  they  comes
  229.          in:
  230.  
  231.          QSCRUB C:\BINKLEY\FILES\*.PKT
  232.  
  233.          To make sure   you   didn't  slip  up  and  type  a  possibly
  234.          "excessively annoying" word:
  235.  
  236.          QSCRUB *.MSG
  237.  
  238.          To make sure your finger didn't slip during the documentation
  239.          development:
  240.  
  241.          QSCRUB QSCRUB.DOC
  242.  
  243.          The QuickBBS Message base is considered a special case due to
  244.          its format.  To process (scrub)  the  QuickBBS  message  base
  245.          type:
  246.  
  247.          QSCRUB MSGTXT.BBS !    (where ! is optional)
  248.  
  249.          QuickScrub could also be used for other message systems:
  250.  
  251.          QSCRUB *.MSG
  252.          QSCRUB *.BBS   (do not use this for QuickBBS!)
  253.  
  254.          You could even  scrub  your log files so that  your  name  is
  255.          invisible to others:
  256.  
  257.          QSCRUB *.LOG   (with "Jason Cox" in QSCRUB.LST)
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.                  QuickScrub Version 1.00 User's Guide - Page 4
  268.  
  269.  
  270.  
  271.                              THE IDEA OF CENSORSHIP
  272.  
  273.          The censoring of  outbound or routed messages is forbidden in
  274.          FidoNet policy.  However, censoring  your  own  message  base
  275.          and/or files is a great way to keep offensive  language  from
  276.          being viewed by  you or your users.  QuickScrub provides that
  277.          option.
  278.  
  279.  
  280.  
  281.                   A SPECIAL THANKS TO QUICKSCRUB BETA TESTERS!
  282.  
  283.                            Bruce Bodger at 1:170/400
  284.                            Noel Crow at 1:170/200
  285.                            Kelly Drown at 1:170/403
  286.                            Danny Wasson at 1:170/235
  287.  
  288.  
  289.  
  290.                           "Let's make ShareWare work!"
  291.  
  292.  
  293.  
  294.                                    QUICKSCRUB
  295.  
  296.          Copyright (C) 1989 by Jason A.  Cox.   ALL  RIGHTS  RESERVED.
  297.          COMMERCIAL USE OF QUICKSCRUB IS NOT PERMITTED WITHOUT WRITTEN
  298.          PERMISSION FROM JASON COX.  A LIMITED LICENSE  IS GRANTED FOR
  299.          THE NON-COMMERCIAL TRIAL  USE  AND  SHAREWARE DISTRIBUTION OF
  300.          QUICKSCRUB.
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.